home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / userbox / publicdomain / o_s-b4_00s / o_s-b.doc < prev    next >
Text File  |  1996-07-28  |  13KB  |  273 lines
  1. $VER: oLIVERS_sTART-bUTTON dOCUMENTATION V4.00, (c)'96 by O.Tennie
  2.  
  3.                     *---------------------------------------*
  4.                    /  ___                ___  __  ,  ___   /
  5.                   /  /  /  /    /  | /  /_   /_/    /__   /
  6.                  /  /__/  /__  /   |/  /__  /\     ___/  /
  7.                 /         ___  ____  __   __  ____      /
  8.                /         /__    /   /_/  /_/   /       /
  9.               /         ___/   /   / /  /\    /       /
  10.              /     __       ____  ____   ___         /
  11.             /     /_/  / /   /     /    /  /  /| /  /
  12.            /     /_/  /_/   /     /    /__/  / |/  /
  13.           *---------------------------------------*
  14.  
  15.                           V 4.00r/s               
  16.  
  17.                   (c)'1996 by Oliver Tennie
  18.  
  19.                 +---------------------------+
  20.                 | This program is SHAREWARE |
  21.                 +---------------------------+
  22.  
  23. Disclaimer:
  24. -----------
  25. The author can not be held responsible for any damages caused by the
  26. program. You use this program at your own risk.
  27.  
  28. Copyright:
  29. ----------
  30. This program (including the documentation and the icons) is 
  31. copyright 1996 by Oliver Tennie. You are not allowed to change/modify
  32. anything or to use anything in your own programs without the written
  33. permission of the author.
  34.  
  35. Distribution:
  36. -------------
  37. The unregistered version may be distributed freely on any disc or cd-rom
  38. as long as the costs for the media does not exceed a "normal" price
  39. (normal means about the price of a Fish/AmiNet cd-rom/disc). This
  40. program may also be distributed on any network, except for the MSN.
  41. It is allowed to put the complete (!) package on the coverdisk of a mag.
  42.  
  43. Shareware:
  44. ----------
  45. This program is shareware. If you use it regulary, you are asked to
  46. send a small fee (see below) to the author. You will get a personalized
  47. version of the program without the limitation (in the unregistered version
  48. only the first 10 programs are read from the configuration-file).
  49.  
  50. To register, just send 15,-DM or 10,-US$ or 10,-UK£ to:
  51.  
  52.  Oliver Tennie
  53.  Efeuweg 9
  54.  22299 Hamburg
  55.  GERMANY
  56.  
  57. ** _NEW_ SPECIAL OFFER: **
  58.   If you register until 31/Aug/96 the registration-fee is only 10,-DM
  59.   (sorry, but no discount for US$ or UK£).
  60.  
  61. Requirements:
  62. -------------
  63. In order to run, this program needs the following:
  64.     - Kickstart / Workbench 2.04 (or higher)
  65.     - ReqTools.library ( (c) Nico Francois)
  66.  
  67. Installation:
  68. -------------
  69. You should copy the program (together with its icon) to your WBStartup-drawer.
  70. You also have to copy the configurationfile (o_s-b4.prefs) to your ENV: and 
  71. your ENVARC: -assign (you can edit it later on from within the program, see 
  72. below). If you used previous versions of o_s-b you may want to convert your 
  73. old data-file into the new format (see below for instructions). After you did
  74. this, you should reboot your Amiga.
  75.  
  76. How to configure o_s-b:
  77. -----------------------
  78. The configuration of o_s-b is stored in the file o_s-b4.prefs. There are two
  79. ways to edit/change/... this file:
  80.  1) The "old" way: You can use your Editor to edit the file ENV:o_s-b.prefs as
  81.     you need it. Then you can convert it using the converter (see below). For a
  82.     description of the old conventions see below (quoted from old document)
  83.  
  84.      The usage of the configuration-file is to tell o_s-b which programs
  85.      can be loaded and how.
  86.      You can define groups, program-titles, the program-path and the 
  87.      cli/shell-command to load the program. o_s-b reads through the
  88.      configuration-file from top to bottom and so programs will always be
  89.      added to the last defined group. 
  90.        !! It is not allowed to add programs without defining a group !!
  91.        !! before, so you'll always have to create at least one group !! 
  92.  
  93.      A valid line starts with one of the following commands (all other lines
  94.      are ignored and can be used for comments): 
  95.  
  96.       ":"  - this shows o_s-b that a new group should be defined
  97.       ">"  - this tells o_s-b the name of the new program
  98.       "!"  - this is the cli/shell-command that will launch the program
  99.              (note: this command always refers to the last given name)
  100.       "#"  - this tells o_s-b in which directory it should change
  101.             (note: this command always refers to the last given name)
  102.  
  103.      Following to the command is the parameter, for example the name of the
  104.      new group or the program-name.
  105.    
  106.      To get an idea how the configuration-file works, just have a look at the
  107.      example in this distribution.
  108.  
  109.  2) The "new" way: You can use the built-in configuration-program of o_s-b. To
  110.     activate it, just click on the picture at the left side of the big window.
  111.     A requester will appear and give you the following four options:
  112.       BACK...     > Exits the configuration
  113.       Add program > Adds a program to the list
  114.       Del program > Removes a program from the list
  115.       Set font    > Set the program-font
  116.  
  117.    Add program: After you select this button, you will be asked to give a name
  118.                 for the new program (not longer than 20 chars). Afterwards you
  119.                 are aked to tell o_s-b the group of the program (if you give a
  120.                 new name, o_s-b will create a new group) (WARNING: the groupname
  121.                 is case-sensitive !!!). Then o_s-b asks you for the path and
  122.                 program to connect to the entry. Simply select the program and
  123.                 click on >OK<.
  124.    Del program: If you click this button, o_s-b will ask you the name of the
  125.                 program to remove from the list. Next o_s-b will ask you for the
  126.                 name of the group in which the program is (here your input is
  127.                 not case-sensitive !). After a security-request, o_s-b removes
  128.                 the entry from the list (and the data-files).
  129.    Set font   : With this button you can select the font which o_s-b will use.
  130.                 The new font will not be set immediately, a restart of the
  131.                 program is needed to make changes take effect. 
  132.                 I suggest not to use too big fonts !!!
  133.  
  134. Usage:
  135. ------
  136. After you installed the program properly (see Installation) and after
  137. you rebooted your Amiga, you shold see a small "Start"-button at the
  138. left bottom of your screen. If you click on it once, a bigger window will
  139. appear with two lists, three buttons and a picture in it. The list on the left
  140. side shows you all the groups you defined in the config-file and the list on 
  141. the right side shows you all programs for the current group. At the bottom
  142. of the window you can see three buttons titled "About" (which will display
  143. some informations), "Close" (which will close the big window) and 
  144. "Quit" (which will exit the program). If you click on the picture at
  145. the left side of the window, the configuration will appear (see above).
  146. To change the current group, just click on an entry from the left list,
  147. the right list will change and you can load a program from it by clicking
  148. it once. 
  149. You can control the lists either with your mouse or with your keyboard.
  150. Following is a list of valid keys and their meaning:
  151. <Curs left>  - left list one entry up
  152. <Curs right> - left list one entry down
  153. <Curs up>    - right list one entry up
  154. <Curs down>  - right list one entry down
  155. <Return>     - load current program
  156. <ESC>        - close big window.
  157. If you are at the top (or bottom) of a list and go one step further in that
  158. direction, o_s-b will go to the last (or first) entry of the list.
  159.  
  160. Using the converter:
  161. --------------------
  162. The converter reads the old config-file ENV:o_s-b.prefs and writes the new
  163. configuration to ENVARC:o_s-b4.prefs and ENV:o_s-b4.prefs. If the old
  164. configuration does not exist, the converter will exit with an error. To load the
  165. converter, you can either click twice on its icon or you can type the name from
  166. a CLI or Shell.
  167.  
  168. Some informations:
  169. ------------------
  170. This program was written using:
  171.    - MaxonPascal V3
  172.  
  173. This program uses:
  174.    - ReqTools.Library, (c) by Nico Francois
  175.    - ReqTools-unit by PackMAN (Falk Zühlsdorff)
  176.  
  177. History:
  178. --------
  179. V1.00 - * initial version
  180.  
  181. V2.00 - * complete rework of the program
  182.  
  183.         * name changed from TaskBar to oLIVER'S_sTART-bUTTON because
  184.           the name TaskBar was already used from another author for
  185.           his program
  186.  
  187.         * directory-changes are now possible
  188.  
  189. V2.01 - * on program-startup the window is no longer activated
  190.           (nasty "bug", because WorkBench was therefore inactive
  191.            on startup, when o_s-b was placed in WBStartup)
  192.  
  193. V2.02 - * o_s-b will now work properly on Workbench-screens with
  194.           resolutions different to 640*256
  195.  
  196. V3.00 - * I rewrote the whole program under Maxon Pascal V3
  197.           (now it's a bit faster, a bit smaller, more compatible
  198.           and has some new functions/enhancements).
  199.  
  200.         * o_s-b does no longer need the assign to t: and it does
  201.           also not need c:execute anymore as I improved the
  202.           way programs are launched (no temporary-file is
  203.           created anymore !)
  204.  
  205.         * the Screen-Hight -setting (I know, that was a small
  206.           grammatical bug :-| ) is no longer needed (and also
  207.           no longer supported, as o_s-b detects automatically 
  208.           the height of your Workbench-screen (anyway you do not
  209.           need to change your config-file, as o_s-b ignores that
  210.           line (as well as all other lines without a command)).
  211.  
  212.         * previos o_s-b-versiones sometimes exited without a 
  213.           reason when the start-button was pressed (especially
  214.           when the cpu was used a lot), this should be fixed now
  215.  
  216. V3.01 - * Some parts of o_s-b can now be controlled with the keyboard.
  217.           You can select the program-entrys using <CursUp>, <CursDown>,
  218.           you can launch a program using <Return> or <Enter> and you
  219.           can close the big window using <Esc>
  220.  
  221.         * o_s-b is now more secure against so called cracking... (I hope)
  222.  
  223. V3.02 - * Added some more keyboard-control. <CursLeft> and <CursRight>
  224.           scroll through the group-list (<CursLeft> scrolls up and
  225.           <CursRight> scrolls down). If your reach the top or bottom of
  226.           the list and you press <CursLeft> or <CursRight> the program
  227.           will jump to the last (when at top of the list) or the first
  228.           (when at bottom of the list) entry.
  229.  
  230. V3.03 - * Added some graphic on the big window (maybe it'll get useful
  231.           in later versions ? I don't know, yet...)
  232.         * Improved the program a bit, removed some useless things
  233.  
  234. V3.04 - * Bug removed: o_s-b allocated memory every time the big window was
  235.           opened but it was only freed again, when the program was exited
  236.         * Introduced a new SPECIAL REGISTRATION OFFER (see section Shareware)
  237.         * Improved (again) the keyboard-handling. If you are at the top of
  238.           the right list and you press <CursUp> again, o_s-b will jump to
  239.           the last entry of that list (and, of course, if you are at the
  240.           bottom of the list and press <CursDown>, o_s-b will jump to the
  241.           first entry of the right list).
  242.         * o_s-b can now use another than the default font. There are two
  243.           new keywords for the configuration-file (env:o_s-b.prefs):
  244.                   FONTNAME=<Name>.font
  245.           and     FONTSIZE=<Size>
  246.           (replace <Name> with the fontname and <Size> with the desired size).
  247.           If the font can not be opened, o_s-b will use topaz-8 instead.
  248.           Be warned: Even if you can select another font, o_s-b is not (yet)
  249.           font-sensitive; this means, too big fonts will make texts go over
  250.           the borders of the buttons and that looks strange... (anyway you
  251.           may try it out once to see what happens...).
  252.           You should have a look at the example configuration-file.
  253.         * Added a DONOTWAIT -statement to the icon, so the Workbench will
  254.           not create an error anymore on startup (I'm sorry for that...)
  255.  
  256. V3.05 - * Windows and buttons are now font-sensitive (with one exception:
  257.           the width of the big window does not change, so using too big fonts
  258.           is still not suggested... but fonts up to a size of 25 work fine)
  259.  
  260.         * There's now a function connected to the graphic at the left side of
  261.           the big window. If you click on it, a configuration-requester will
  262.           open. This will NOT work until o_s-b V4.00 (see **IMPORTANT**).
  263.  
  264.         * This will probaly be the last V3.xy-version of o_s-b. V4.00 is 
  265.           in development and will be released soon.
  266.  
  267. V4.00 - * New configuration-file-format
  268.         * Configuration-editor integrated
  269.         * Documentation now also in german language
  270.         * Converter for old configuration-files
  271.         * some internal optimisiations (using of advantages from the new
  272.           configuration-file-format)
  273.